org.eclipse.vtp.framework.engine.http
Class ControllerDocument

java.lang.Object
  org.eclipse.vtp.framework.engine.http.ControllerDocument

All Implemented Interfaces:

IDocument

public class ControllerDocument
extends java.lang.Object
implements IDocument

ControllerDocument.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.platforms.IDocument

DEFAULT_CONTENT_TYPE

Constructor Summary

ControllerDocument()
Creates a new ControllerDocument.

Method Summary

java.lang.String	getContentType() Returns a string representing the MIME type of XML document this instance produces.
java.lang.String	getDocumentType() Returns a string representing the dialect of XML document this instance produces.
java.lang.String[]	getOutgoingDataNames(java.lang.String path)
java.lang.Object	getOutgoingDataValue(java.lang.String path, java.lang.String name)
java.lang.String[]	getOutgoingPaths()
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the target process.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the current process resumes.
java.lang.String	getTarget() Returns the URI identifying the process to transfer control to.
java.lang.String[]	getVariableNames() Returns the names of the variables that will be passed to the target process.
java.lang.Object	getVariableValue(java.lang.String targetVariableName) Returns the name of the variable in the current process that will be set as the specified variable in the target process.
void	setOutgoingDataValue(java.lang.String path, java.lang.String name, java.lang.Object value)
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setTarget(java.lang.String targetProcessURI) Sets the URI identifying the process to transfer control to.
void	setVariableValue(java.lang.String targetVariableName, java.lang.Object localVariableName) Sets the name of the variable in the current process that will be set as the specified variable in the target process.
javax.xml.transform.Source	toXMLSource() Creates and returns an XML representation of this document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ControllerDocument

public ControllerDocument()

Creates a new ControllerDocument.

Method Detail

getTarget

public java.lang.String getTarget()

Returns the URI identifying the process to transfer control to.

Returns:

The URI identifying the process to transfer control to.

setTarget

public void setTarget(java.lang.String targetProcessURI)

Sets the URI identifying the process to transfer control to.

Parameters:

targetProcessURI - The URI identifying the process to transfer control to.

getVariableNames

public java.lang.String[] getVariableNames()

Returns the names of the variables that will be passed to the target process.

Returns:

The names of the variables that will be passed to the target process.

getVariableValue

public java.lang.Object getVariableValue(java.lang.String targetVariableName)

Returns the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

Returns:

The name of the variable in the current process that will be set as the specified variable in the target process.

setVariableValue

public void setVariableValue(java.lang.String targetVariableName,
                             java.lang.Object localVariableName)

Sets the name of the variable in the current process that will be set as the specified variable in the target process.

Parameters:

targetVariableName - The name of the variable in the target process.

localVariableName - The name of the variable in the current process to pass to the target process.

getOutgoingPaths

public java.lang.String[] getOutgoingPaths()

getOutgoingDataNames

public java.lang.String[] getOutgoingDataNames(java.lang.String path)

getOutgoingDataValue

public java.lang.Object getOutgoingDataValue(java.lang.String path,
                                             java.lang.String name)

setOutgoingDataValue

public void setOutgoingDataValue(java.lang.String path,
                                 java.lang.String name,
                                 java.lang.Object value)

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the target process.

Returns:

The names of the parameters that will be returned from the target process.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the current process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

getContentType

public java.lang.String getContentType()

Description copied from interface: IDocument

Returns a string representing the MIME type of XML document this instance produces.

Specified by:

getContentType in interface IDocument

Returns:

A string representing the MIME type of XML document this instance produces.

getDocumentType

public java.lang.String getDocumentType()

Description copied from interface: IDocument

Returns a string representing the dialect of XML document this instance produces.

Specified by:

getDocumentType in interface IDocument

Returns:

A string representing the dialect of XML document this instance produces.

toXMLSource

public javax.xml.transform.Source toXMLSource()
                                       throws java.lang.IllegalStateException

Description copied from interface: IDocument

Creates and returns an XML representation of this document.

Specified by:

toXMLSource in interface IDocument

Returns:

An XML transformation source object that can be used with the javax.xml.transform API.

Throws:

java.lang.IllegalStateException - If any aspect of this document's state prevents it from being transformed into XML.